﻿<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>

  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <title>Class SparseMatrix&lt;T&gt;.Column </title>
    <meta name="viewport" content="width=device-width">
    <meta name="title" content="Class SparseMatrix&lt;T&gt;.Column ">
    <meta name="generator" content="docfx ">
  
    <link rel="shortcut icon" href="../api/images/favicon.ico">
    <link rel="stylesheet" href="../styles/docfx.vendor.css">
    <link rel="stylesheet" href="../styles/docfx.css">
    <link rel="stylesheet" href="../styles/main.css">
    <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet"> 
    <meta property="docfx:navrel" content="../toc.html">
    <meta property="docfx:tocrel" content="toc.html">
    <script type="text/javascript" async="" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-MML-AM_CHTML"></script>
  
  
  
  </head>  <body data-spy="scroll" data-target="#affix" data-offset="120">
    <div id="wrapper">
      <header>

        <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
          <div class="container">
            <div class="navbar-header">
              <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
                <span class="sr-only">Toggle navigation</span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
              </button>

              <a class="navbar-brand" href="../index.html">
                <img id="logo" class="svg" src="../api/images/favicon.svg" alt="">
              </a>
            </div>
            <div class="collapse navbar-collapse" id="navbar">
              <form class="navbar-form navbar-right" role="search" id="search">
                <div class="form-group">
                  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
                </div>
              </form>
            </div>
          </div>
        </nav>

        <div class="subnav navbar navbar-default">
          <div class="container hide-when-search" id="breadcrumb">
            <ul class="breadcrumb">
              <li></li>
            </ul>
          </div>
        </div>
      </header>
      <div role="main" class="container body-content hide-when-search">

        <div class="sidenav hide-when-search">
          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
          <div class="sidetoggle collapse" id="sidetoggle">
            <div id="sidetoc"></div>
          </div>
        </div>
        <div class="article row grid-right">
          <div class="col-md-10">
            <article class="content wrap" id="_content" data-uid="SpiceSharp.Algebra.SparseMatrix`1.Column">



  <h1 id="SpiceSharp_Algebra_SparseMatrix_1_Column" data-uid="SpiceSharp.Algebra.SparseMatrix`1.Column" class="text-break">Class SparseMatrix&lt;T&gt;.Column</h1>
  <div class="markdown level0 summary"><p>A class that keeps track of a linked list of matrix elements for a column.</p>
</div>
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance">
    <h5>Inheritance</h5>
    <div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
    <div class="level1"><span class="xref">SparseMatrix&lt;T&gt;.Column</span></div>
  </div>
  <div class="inheritedMembers">
    <h5>Inherited Members</h5>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
    </div>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
    </div>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
    </div>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
    </div>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
    </div>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
    </div>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
    </div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="SpiceSharp.html">SpiceSharp</a>.<a class="xref" href="SpiceSharp.Algebra.html">Algebra</a></h6>
  <h6><strong>Assembly</strong>: SpiceSharp.dll</h6>
  <h5 id="SpiceSharp_Algebra_SparseMatrix_1_Column_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">protected class SparseMatrix&lt;T&gt;.Column</code></pre>
  </div>
  <h3 id="properties">Properties
</h3>
  <a id="SpiceSharp_Algebra_SparseMatrix_1_Column_FirstInColumn_" data-uid="SpiceSharp.Algebra.SparseMatrix`1.Column.FirstInColumn*"></a>
  <h4 id="SpiceSharp_Algebra_SparseMatrix_1_Column_FirstInColumn" data-uid="SpiceSharp.Algebra.SparseMatrix`1.Column.FirstInColumn">FirstInColumn</h4>
  <div class="markdown level1 summary"><p>Gets the first element in the column.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public SparseMatrix&lt;T&gt;.Element FirstInColumn { get; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="SpiceSharp.Algebra.SparseMatrix-1.html">SparseMatrix</a>&lt;T&gt;.<a class="xref" href="SpiceSharp.Algebra.SparseMatrix-1.Element.html">Element</a></td>
        <td><p>The first element in the column.</p>
</td>
      </tr>
    </tbody>
  </table>
  <a id="SpiceSharp_Algebra_SparseMatrix_1_Column_LastInColumn_" data-uid="SpiceSharp.Algebra.SparseMatrix`1.Column.LastInColumn*"></a>
  <h4 id="SpiceSharp_Algebra_SparseMatrix_1_Column_LastInColumn" data-uid="SpiceSharp.Algebra.SparseMatrix`1.Column.LastInColumn">LastInColumn</h4>
  <div class="markdown level1 summary"><p>Gets the last element in the column.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public SparseMatrix&lt;T&gt;.Element LastInColumn { get; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="SpiceSharp.Algebra.SparseMatrix-1.html">SparseMatrix</a>&lt;T&gt;.<a class="xref" href="SpiceSharp.Algebra.SparseMatrix-1.Element.html">Element</a></td>
        <td><p>The last element in the column.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="methods">Methods
</h3>
  <a id="SpiceSharp_Algebra_SparseMatrix_1_Column_Clear_" data-uid="SpiceSharp.Algebra.SparseMatrix`1.Column.Clear*"></a>
  <h4 id="SpiceSharp_Algebra_SparseMatrix_1_Column_Clear" data-uid="SpiceSharp.Algebra.SparseMatrix`1.Column.Clear">Clear()</h4>
  <div class="markdown level1 summary"><p>Clears all matrix elements in the column.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public void Clear()</code></pre>
  </div>
  <a id="SpiceSharp_Algebra_SparseMatrix_1_Column_Insert_" data-uid="SpiceSharp.Algebra.SparseMatrix`1.Column.Insert*"></a>
  <h4 id="SpiceSharp_Algebra_SparseMatrix_1_Column_Insert_SpiceSharp_Algebra_SparseMatrix__0__Element_" data-uid="SpiceSharp.Algebra.SparseMatrix`1.Column.Insert(SpiceSharp.Algebra.SparseMatrix{`0}.Element)">Insert(Element)</h4>
  <div class="markdown level1 summary"><p>Insert an element in the column. This method assumes an element does not exist at its indices!</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public void Insert(SparseMatrix&lt;T&gt;.Element newElement)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="SpiceSharp.Algebra.SparseMatrix-1.html">SparseMatrix</a>&lt;T&gt;.<a class="xref" href="SpiceSharp.Algebra.SparseMatrix-1.Element.html">Element</a></td>
        <td><span class="parametername">newElement</span></td>
        <td><p>The new element to insert.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="exceptions">Exceptions</h5>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Condition</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.argumentnullexception">ArgumentNullException</a></td>
        <td><p>Thrown if <code class="paramref">newElement</code> is <code>null</code>.</p>
</td>
      </tr>
    </tbody>
  </table>
  <a id="SpiceSharp_Algebra_SparseMatrix_1_Column_Remove_" data-uid="SpiceSharp.Algebra.SparseMatrix`1.Column.Remove*"></a>
  <h4 id="SpiceSharp_Algebra_SparseMatrix_1_Column_Remove_SpiceSharp_Algebra_SparseMatrix__0__Element_" data-uid="SpiceSharp.Algebra.SparseMatrix`1.Column.Remove(SpiceSharp.Algebra.SparseMatrix{`0}.Element)">Remove(Element)</h4>
  <div class="markdown level1 summary"><p>Remove an element from the column.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public void Remove(SparseMatrix&lt;T&gt;.Element element)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="SpiceSharp.Algebra.SparseMatrix-1.html">SparseMatrix</a>&lt;T&gt;.<a class="xref" href="SpiceSharp.Algebra.SparseMatrix-1.Element.html">Element</a></td>
        <td><span class="parametername">element</span></td>
        <td><p>The element to be removed.</p>
</td>
      </tr>
    </tbody>
  </table>
  <a id="SpiceSharp_Algebra_SparseMatrix_1_Column_Swap_" data-uid="SpiceSharp.Algebra.SparseMatrix`1.Column.Swap*"></a>
  <h4 id="SpiceSharp_Algebra_SparseMatrix_1_Column_Swap_SpiceSharp_Algebra_SparseMatrix__0__Element_SpiceSharp_Algebra_SparseMatrix__0__Element_System_Int32_System_Int32_" data-uid="SpiceSharp.Algebra.SparseMatrix`1.Column.Swap(SpiceSharp.Algebra.SparseMatrix{`0}.Element,SpiceSharp.Algebra.SparseMatrix{`0}.Element,System.Int32,System.Int32)">Swap(Element, Element, int, int)</h4>
  <div class="markdown level1 summary"><p>Swap two elements in the row, <code class="paramref">first</code> and <code class="paramref">rowFirst</code>
are supposed to come first in the row. Does not update row pointers!</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public void Swap(SparseMatrix&lt;T&gt;.Element first, SparseMatrix&lt;T&gt;.Element second, int rowFirst, int rowSecond)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="SpiceSharp.Algebra.SparseMatrix-1.html">SparseMatrix</a>&lt;T&gt;.<a class="xref" href="SpiceSharp.Algebra.SparseMatrix-1.Element.html">Element</a></td>
        <td><span class="parametername">first</span></td>
        <td><p>The first matrix element.</p>
</td>
      </tr>
      <tr>
        <td><a class="xref" href="SpiceSharp.Algebra.SparseMatrix-1.html">SparseMatrix</a>&lt;T&gt;.<a class="xref" href="SpiceSharp.Algebra.SparseMatrix-1.Element.html">Element</a></td>
        <td><span class="parametername">second</span></td>
        <td><p>The second matrix element.</p>
</td>
      </tr>
      <tr>
        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></td>
        <td><span class="parametername">rowFirst</span></td>
        <td><p>The first row.</p>
</td>
      </tr>
      <tr>
        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></td>
        <td><span class="parametername">rowSecond</span></td>
        <td><p>The second row.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="exceptions">Exceptions</h5>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Condition</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.argumentnullexception">ArgumentNullException</a></td>
        <td><p>Thrown if both <code class="paramref">first</code> and <code class="paramref">second</code> are <code>null</code>.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="extensionmethods">Extension Methods</h3>
  <div>
      <a class="xref" href="SpiceSharp.Utility.html#SpiceSharp_Utility_ThrowIfNull__1___0_System_String_">Utility.ThrowIfNull&lt;T&gt;(T, string)</a>
  </div>

</article>
          </div>

          <div class="hidden-sm col-md-2" role="complementary">
            <div class="sideaffix">
              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
                <h5>In this article</h5>
                <div></div>
              </nav>
            </div>
          </div>
        </div>
      </div>

      <footer>
        <div class="grad-bottom"></div>
        <div class="footer">
          <div class="container">
            <span class="pull-right">
              <a href="#top">Back to top</a>
            </span>
      
      <span>Generated by <strong>DocFX</strong></span>
          </div>
        </div>
      </footer>
    </div>

    <script type="text/javascript" src="../styles/docfx.vendor.min.js"></script>
    <script type="text/javascript" src="../styles/docfx.js"></script>
    <script type="text/javascript" src="../styles/main.js"></script>
  </body>
</html>
